feat: adding functions and sessions apis #1159

bdimitrijoski · 2024-09-24T22:26:38Z

This PR adds sessions API and partial support for functions API in the SDK.
I covered the APIs with unit tests and added code samples.

There were some problems (mostly, generated some types with any and later it failed on lint) with codegen when I tried to generate the types for functions so at the end I skipped codgen for this API.

* fix: add sort properties to filter queries * fix: fix typo

- @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected]

* test(alerts): skip flaky test temporarily * chore(package): update yarn

- @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected]

* fix: release to override a bad release * chore: skip validateDocLinks due to a bad release

- @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected]

* chore: re-enable temporary disabled ci check * chore: update yarn.lock

* fix: create 50 alerts for cursor pagination test * linting * use nextCursor * remove comment * linting * use int for limit * add client and cogniterrors in test file * linting * remove unnecessary expectation

* fix: remove deprecated labels properties * feat: add active property to integrations * fix: remove deprecated lastUpdatedTime property * fix: add missing versionNumber property * fix: make filter optional

- @cognite/[email protected]

polomani · 2024-09-30T08:01:37Z

packages/stable/src/exports.gen.ts

+  AnnotationsCogmonoAnnotationTypesDiagramsAssetLink,
+  AnnotationsCogmonoAnnotationTypesDiagramsInstanceLink,
+  AnnotationsCogmonoAnnotationTypesImagesAssetLink,
+  AnnotationsCogmonoAnnotationTypesImagesInstanceLink,
+  AnnotationsCogmonoAnnotationTypesPrimitivesGeometry2DGeometry,
+  AnnotationsCogmonoAnnotationTypesPrimitivesGeometry3DGeometry,


looks like a breaking change? any way possible to keep the old names?

That's what annoys me the most, I don't have control over codegen and this is a change coming from the tool. How can I avoid this breaking change?

My advice is not to use it since you spend more time working around it than it requires writing a few type definitions.

but maybe @andersfylling or @BugGambit have a better idea

There is a discussion about this specific breaking change here: #1120 (comment)
I suggest:

Revert the breaking change.

Change the base branch to release-v10 where we, in a few days, will release a new SDK major version where breaking changes are allowed.

@polomani how can I keep the old names?

packages/stable/src/api/functions/functionsApi.ts

BugGambit

Nice PR. I left some comments.
In retro, I believe the PR should have been two PRs. One for Functions and one for Sessions.

BugGambit · 2024-09-30T09:47:52Z

packages/stable/src/api/functions/functionCallsApi.ts

+  /**
+   * @hidden
+   */


Why hidden?

Snippets or samples, one of those tools was failing

Ok, we should look into that. @hidden will hide this endpoint from the documentation.
I can look into it.

I just tested and this works:

/** * [List function calls](https://api-docs.cognite.com/20230101/tag/Function-calls/operation/postFunctionsCall) * * ```js * client.functions.call(123, { nonce: 'abc' } ) * ``` */

🤷

BugGambit · 2024-09-30T09:50:27Z

packages/stable/src/__tests__/api/functions.unit.spec.ts

+      code: 400,
+      message: 'Could not build function.',
+    },
+  } as CogniteFunction;


Why as CogniteFunction vs const mockFunction: CogniteFunction = {}?

Isn't doing the same?

Hm, not completely. Both will result in mockFunction being recognized as the type CogniteFunction, but as CogniteFunction will ignore type errors.

type Foo = { bar: number; } const a: Foo = {} // this will fail as `bar` is missing const b = {} as Foo; // this will NOT fail

BugGambit · 2024-09-30T09:54:12Z

packages/stable/src/api/functions/functionsApi.ts

+  /**
+   * @hidden
+   */
+  public get calls() {


What is this used for and why is it hidden?

This is pointing to the function calls methods (API) example:
functionsApi.calls.list()

It is hidden because the snippets or samples tools were failing

BugGambit · 2024-09-30T09:56:15Z

packages/stable/src/api/functions/functionsApi.ts

+  /**
+   * @hidden
+   */
+  async limits(): Promise<HttpResponse<FunctionsLimitsResponse>> {


Why is it hidden?

scripts/extractCodeSnippets.js

BugGambit · 2024-10-01T13:22:58Z

packages/stable/src/api/functions/types.gen.ts

+export interface FunctionCallRequest {
+  // biome-ignore lint/suspicious/noExplicitAny: couldn't find correct type definition.
+  data?: any;
+  // biome-ignore lint/suspicious/noExplicitAny: couldn't find correct type definition.


Are these comments auto-generated 🤔 ?

E.g. nonce here should be a string

Heh, no, since I turned off the auto-generated types for this API I can update the types, thanks :)

scripts/extractCodeSnippets.js

Co-authored-by: Fredrik Anfinsen <[email protected]>

bdimitrijoski · 2024-10-30T14:20:12Z

Closing this PR as priorities changed and I unfortunately I have to work on something else and don't have time to finish this PR

bkuzma and others added 16 commits August 22, 2024 11:00

feat(simint): add sort property to filter queries (#1134)

b293eee

* fix: add sort properties to filter queries * fix: fix typo

chore(release): publish new package versions [skip ci]

4edc3c6

- @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected]

test(beta): skip flaky alerts api test temporarily (#1133)

bb7f9cb

* test(alerts): skip flaky test temporarily * chore(package): update yarn

fix(units): correct external id type (#1137)

80161a3

chore(release): publish new package versions [skip ci]

2be110f

- @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected]

fix: dummy release to override a bad one (#1139)

5b036da

* fix: release to override a bad release * chore: skip validateDocLinks due to a bad release

chore(release): publish new package versions [skip ci]

80869c9

- @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected] - @cognite/[email protected]

chore: re-enable temporary disabled ci check (#1143)

860f519

* chore: re-enable temporary disabled ci check * chore: update yarn.lock

test: fix test for pagination cursor (#1138)

a3e9106

* fix: create 50 alerts for cursor pagination test * linting * use nextCursor * remove comment * linting * use int for limit * add client and cogniterrors in test file * linting * remove unnecessary expectation

feat(simint): add and remove properties from simulators API (#1147)

4cd6467

* fix: remove deprecated labels properties * feat: add active property to integrations * fix: remove deprecated lastUpdatedTime property * fix: add missing versionNumber property * fix: make filter optional

chore(release): publish new package versions [skip ci]

70df59a

- @cognite/[email protected]

feat: adding functions and sessions apis

abaa32d

fix: adding unit tests

0b53e68

fix: fixed lint

e8987f9

fix: removing console logs

42cdb65

chore: adding code examples

818f053

bdimitrijoski self-assigned this Sep 25, 2024

bdimitrijoski added 6 commits September 25, 2024 11:55

fix: fixing lint

4490dd9

fix: fixing types and docs

bf1bc0b

fix: fixed lint

87e3fc4

chore: commited auto-generated types

be71749

fix: fixed build

f515aa1

fix: fixed codegen

2c706fc

bdimitrijoski marked this pull request as ready for review September 30, 2024 07:20

bdimitrijoski requested review from a team and BugGambit as code owners September 30, 2024 07:20

polomani reviewed Sep 30, 2024

View reviewed changes

packages/stable/src/api/functions/functionsApi.ts Show resolved Hide resolved

polomani reviewed Sep 30, 2024

View reviewed changes

packages/stable/src/api/functions/functionsApi.ts Show resolved Hide resolved

polomani reviewed Sep 30, 2024

View reviewed changes

packages/stable/src/api/functions/functionsApi.ts Show resolved Hide resolved

BugGambit reviewed Sep 30, 2024

View reviewed changes

BugGambit reviewed Oct 1, 2024

View reviewed changes

scripts/extractCodeSnippets.js Outdated Show resolved Hide resolved

bdimitrijoski added 2 commits October 17, 2024 14:07

fix: rebase with v-10

ec3ef81

fix: fixing build issues

9058fe5

bdimitrijoski requested review from andersfylling and a team as code owners October 17, 2024 14:44

bdimitrijoski requested review from a team October 17, 2024 14:44

bdimitrijoski requested a review from a team as a code owner October 17, 2024 14:44

bdimitrijoski changed the base branch from master to release-v10 October 25, 2024 00:52

bdimitrijoski and others added 2 commits October 25, 2024 02:52

Merge branch 'release-v10' into bd/add-ai-and-cognite-functions-apis

3c86849

Update scripts/extractCodeSnippets.js

6c60222

Co-authored-by: Fredrik Anfinsen <[email protected]>

bdimitrijoski closed this Oct 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adding functions and sessions apis #1159

feat: adding functions and sessions apis #1159

bdimitrijoski commented Sep 24, 2024 •

edited

Loading

polomani Sep 30, 2024

bdimitrijoski Sep 30, 2024

polomani Sep 30, 2024

BugGambit Sep 30, 2024

bdimitrijoski Sep 30, 2024

BugGambit left a comment

BugGambit Sep 30, 2024

bdimitrijoski Sep 30, 2024

BugGambit Sep 30, 2024

BugGambit Oct 1, 2024

BugGambit Sep 30, 2024

bdimitrijoski Sep 30, 2024

BugGambit Sep 30, 2024

BugGambit Sep 30, 2024

bdimitrijoski Sep 30, 2024

BugGambit Sep 30, 2024

BugGambit Oct 1, 2024

BugGambit Oct 1, 2024

bdimitrijoski Oct 25, 2024 •

edited

Loading

bdimitrijoski commented Oct 30, 2024

feat: adding functions and sessions apis #1159

feat: adding functions and sessions apis #1159

Conversation

bdimitrijoski commented Sep 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BugGambit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bdimitrijoski Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

bdimitrijoski commented Oct 30, 2024

bdimitrijoski commented Sep 24, 2024 •

edited

Loading

bdimitrijoski Oct 25, 2024 •

edited

Loading