Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package-configuration/crossplane.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ spec:
- apiVersion: pkg.crossplane.io/v1
kind: Function
package: ghcr.io/crossplane/function-template-typescript
version: ">=v0.2.0"
version: ">=v0.3.0"
# Automatically set ready status for resources
- apiVersion: pkg.crossplane.io/v1
kind: Function
Expand Down
30 changes: 30 additions & 0 deletions src/function.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ import {
getDesiredComposedResources,
getDesiredCompositeResource,
getObservedCompositeResource,
getObservedComposedResources,
getCondition,
hasCapability,
Capability,
type FunctionHandler,
type Logger,
} from '@crossplane-org/function-sdk-typescript';
Expand Down Expand Up @@ -54,6 +58,15 @@ export class Function implements FunctionHandler {
let rsp = to(req);

try {
// Example: Check Crossplane capabilities
// hasCapability() allows checking what features are supported by the Crossplane version
// Starting with 2.2.0 Crossplane added the ability to download schemas.
const capabilities = {
requiredResources: hasCapability(req, Capability.CAPABILITY_REQUIRED_RESOURCES),
requiredSchemas: hasCapability(req, Capability.CAPABILITY_REQUIRED_SCHEMAS),
};
logger?.info({ capabilities }, 'Crossplane capabilities detected');

// Get our Observed Composite
const observedComposite = getObservedCompositeResource(req);
logger?.debug({ observedComposite }, 'Observed composite resource');
Expand Down Expand Up @@ -210,6 +223,23 @@ export class Function implements FunctionHandler {

desiredComposed['deployment'] = fromModel(deployment);

// Example: Check the conditions of the observed deployment
// getCondition() extracts status conditions and returns "Unknown" if not found
const observedComposed = getObservedComposedResources(req);
const observedDeployment = observedComposed['deployment'];
if (observedDeployment?.resource) {
const availableCondition = getCondition(observedDeployment.resource, 'Available');
const progressingCondition = getCondition(observedDeployment.resource, 'Progressing');
logger?.info(
{
deployment: observedDeployment.resource.metadata?.name,
available: availableCondition.status,
progressing: progressingCondition.status,
},
'Deployment conditions'
);
}

// Create Ingress if config is provided
if (ingressConfig && Object.keys(ingressConfig).length > 0) {
const ingress = new Ingress({
Expand Down
1 change: 0 additions & 1 deletion src/test-helpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,6 @@ export function assertResourceTypes(response: RunFunctionResponse, expectedTypes
* Run all assertions for a test case
*/
export function assertTestCase(response: RunFunctionResponse, testCase: TestCase) {

if (testCase.expected.resources) {
assertResources(response, testCase.expected.resources);
}
Expand Down