10.0.1 (2023-09-14)

Updating to latest versions of internal packages including:

passport
auth0, openidconnect & saml passport strategies
jsonwebtoken
node-fetch
webpack

10.0.0 (2023-08-23)

BREAKING CHANGES

NestJS 10:

This may not require any changes but please read official migration guide: https://docs.nestjs.com/migration-guide

In general:

Update to NestJS 10
Update all nest dependencies to latest
Update Typescript to v5
Update all google-cloud libs to latest

9.0.1 (2023-08-17)

Minor change in the server-start script to remove use of 'localhost' when starting and listening for start of datastore emulator.

9.0.0 (2021-11-10)

Update to NestJS 8
Update to io-ts 2
Update other non-breaking dependencies
Update to TypeScript 4.4 (some dependencies required this to build)

BREAKING CHANGES

NestJS 8:

This may not require any changes but please read official migration guide: https://docs.nestjs.com/migration-guide

In general:

Update all nest dependencies to latest
Update rxjs to v7

IOTS 2:

A few changes likely required for this:

Add fp-ts dependency
Change any code using isLeft as example below

OLD:

  import { reporter } from 'io-ts-reporters';
  import { ThrowReporter } from 'io-ts/lib/ThrowReporter';
  ...
  
  const validationResult = schema.decode(inputValue);

  if (validationResult.isLeft()) {
    throw ThrowReporter.report(validationResult);
  }

  return validationResult.value;

NEW:

  import iotsReporter from 'io-ts-reporters';
  import { isLeft } from 'fp-ts/lib/Either';
  ...

  const validationResult = schema.decode(inputValue);

  if (isLeft(validationResult)) {
    throw new Error(iotsReporter.report(validationResult).join(', '));
  }

  return validationResult.right;

8.2.1 (2021-11-08)

Add SearchableRespository reindex method to batch requests to cater for 200 max allowed for by GAE search service.

8.2.0 (2021-08-20)

Make local task queue implementation call the task url asynchronously - so requests to enqueue will return immediately rather than waiting for downstream request to complete

8.1.2 (2021-08-18)

Update @google-cloud dependencies and others with high vulnerabilities
Update dev dependencies

8.1.1 (2021-05-03)

Merge from branch release/7.x. Fix priming of the DataLoader cache, clear first, then prime, as per the documented DataLoader API. Also clear the parent context's cache on each update.

8.1.0 (2021-04-06)

Use a task queue to send activation and password reset emails. Relies on a default queue being present and cloudtasks API enabled.

8.0.1 (2021-03-22)

Fix task scheduling. The inSeconds parameter into the function async enqueue(taskName: string, payload: any = {}, inSeconds?: number) was taking no effect prior to this commit.

8.0.0 (2021-03-09)

Support for GraphQL code-first approach so we do not need to manually craft types and graphql schema files.

BREAKING CHANGES

This is a breaking release that is aimed at Code First style resolver/model definitions. If you still want to use graphql schema files then we suggest you stick with v7 releases. Although there may be ways to use this release with some overrides, there has not been significant effort to test this and it may require some further tweaks.

Graphql schema files will not work in this release (see above).

The me GraphQL Query has been removed from this library since it is aimed at returning the User that the application defines itself. There is no reason to include this in the base library, so define this in your own library - perhaps a user.resolver.ts if you have one. Suggested implementation

    @AllowAnonymous()
    @Query(() => User, { nullable: true })
    async me(_req: void, _args: void, context: Context): Promise<User | undefined> {
      if (context.user) {
        return context.user as User;
      }
    }

Applications need to define their own GraphQLModule. When initialising your GCloudModule add an entry fore GraphQLModule. Example below (the last option is the new one):

  GCloudModule.forConfiguration({
    configurationModule: ConfigurationModule,
    userModule: UserModule,
    graphQLModule: GraphQLModule.forRoot({
      path: '/api/graphql',
      context: (props: any) => props.req?.context,
      autoSchemaFile: configurationProvider.isDevelopment() ? 'schema.gql' : true,  // in-memory for GCP but generate file locally to help troubleshoot
    }),
  }),

7.5.5 (2021-01-15)

Update auth0 with a secondary callback that allows apps to get at the login identifier from the UserService

7.5.4 (2020-12-11)

Update auth0 with a callback that allows apps to override email as the login identifier

7.5.3 (2020-11-20)

Resolve all vulnerabilities internally with npm audit fix to update some minor versions of internal dependencies.

7.5.2 (2020-11-10)

Provide a way for subclasses of AbstractUserService to get user id by email address.

7.5.1 (2020-11-10)

InviteCallbacks are supplied the context so they can call through to repositories. Skip version 7.5.0.

7.5.0 (2020-11-10)

Enable callbacks for when inviting user. Currently supports afterInvite and afterActivate. To utilise, register an @Injectable class that implements InviteCallbacks and define one or more methods. Register with the name of constant INVITE_CALLBACKS.

7.4.3 (2020-10-27)

Provide a hook by way of a callback method to enable library consumers to augment the auth0 options passed through to 'passport.authenticate()'.

7.4.2 (2020-10-21)

Enable tasks to be served by the originating version rather than defaulting to the version taking the traffic. Useful for offline and canary style deployments. Add the following property into your env props to enable:

serviceTasksOnThisVersion: true

7.4.1 (2020-10-14)

Fix @Task() and @Cron() decorators to only allow invocation based on the presence of the respective 'x-appengine-taskname' & 'x-appengine-cron' google headers. Prior to this fix any authenticated user could invoke cron/task endpoints

7.4.0 (2020-09-20)

Update @google-cloud/tasks to latest and update usage of it in tasks.ts to use v2 instead of v2beta3
Added optional parameter for enqueuing tasks with a delay

7.3.0 (2020-09-02)

Update google dependencies to latest

7.2.0 (2020-07-23)

Allow multiple sort columns when querying, backwards compatible. Examples below

    // sort by multiple fields - NOTE you need an entry in index.yaml for a composite index
    myRepository.query(context, {
      sort: [
        {
          property: 'myProp1',
          options: {
            descending: true,
          },
        },
        {
          property: 'myProp2',
        },
      ],
    })

    // sort by single field - existing
    myRepository.query(context, {
      sort: {
      property: 'myProp1',
      options: {
        descending: true,
      },
    })

Allow sort by the id field which is called __key__ in datastore. Updated typescript types to allow this field name. Note that if you try to sort by id it will not work and return no results - you must use __key__.
Repository implementations require an entity with id: string. This is exposed as BaseEntity so client projects can reference it as a type if required.

7.1.0 (2020-05-26) 7.x goes GA

Here is a summary of changes since v6. Changelog entries for v7 release candidates have been removed and are summarised here:

Update to NestJS 7
Use cls-hooked to have thread-local-like functionality within app. We call it request scope.

Allow context to be accessed via getContext() without having to pass it around (uses request scope to store). Example usage:

import { getContext } from '@mondomob/gae-node-nestjs';

...
class MyClass {

    myFunc() {
        const context = getContext();
        // use it for the repositories, or to check access without requiring it as a parameter
    }
}

Allow request log bundling per http request (uses request scope) if enabled. No changes required to calling loggers - just for the logger interface definition (see migration guide). See https://github.com/googleapis/nodejs-logging-bunyan#using-as-an-express-middleware
Request scope and log bundling are disabled by default, but can be enable via config (see migration guide).

Breaking changes - migrating from v6

Potential breaking changes with NestJS 7. This is a smaller jump than v5 to v6 and the steps below should capture required changges. See https://docs.nestjs.com/migration-guide for further info
- Ensure you have express 4.17.1 or later. This is listed as a peerDepedency now
- Since our example project updated from nest v5 to v7 we can't be sure if this is new with v7 or v6 but modules now do not implicitly import nested modules. A prime example is if module A imports Module B and Module B imports ConfigurationModule, then you will need to expliclty include ConfigurationModule in Module A's imports if it depends on components within that module. If you are affected by this it will be obvious when you start your server and see a message similar to Nest can't resolve dependencies of MyProvider (?). Please make sure that the argument XX at index [0] is available in the YY context

configureExpress() is now an async function. Change your bootstrap.ts or equivalent. Add await to the call as per below.

// BEFORE
export async function bootstrap() {
    ...
    configureExpress(expressApp, {
        ...
    });
}

// AFTER
export async function bootstrap() {
    ...
    await configureExpress(expressApp, {
        ...
    });
}

We use our own Logger interface for rootLogger and createLogger. Replace all bunyan imports that define Logger with import { logger } from '@mondomob/gae-node-nestjs';

To enable request scope for being able to retrieve context via getContext() then you need to enable this via the enabled flag in config and to enable log bundling you need to set the logBundlingEnabled flag.

update default.json or similar config

   "requestScope": {
     "enabled": true,
     "logBundlingEnabled": true
   },

update your config.provider.ts (or whatever you call your file that defines your configuration provider) to define a getter for requestScope. Example additions below:

...
const requestScope = t.partial({
  enabled: t.boolean,
});
...
const Config = t.intersection([
  t.interface({
    ...
  }),
  t.partial({
    requestScope,
    ...
  }),
]);

export class ConfigurationProvider implements Configuration {
  configuration: t.TypeOf<typeof Config>;
  ...

  get requestScope() {
    return this.configuration.requestScope;
  }
}

6.0.1 (2020-04-21)

Non release candidate version. New version publish only

6.0.0-rc.2 (2020-04-21)

More internal dependency updates

6.0.0-rc.1 (2020-04-21)

Fix dependency issue loading graphql
Update internal dependencies where not major breaking

6.0.0-rc.0 (2020-03-00)

Update to NestJS 6

Breaking changes:

Lots of changes:

Follow official migration guide: https://docs.nestjs.com/v6/migration-guide
Add @nestjs/platform-express

npm install @nestjs/platform-express

Update bootstrap.ts to use express platform

const app = await NestFactory.create(AppModule, new ExpressAdapter(expressApp), {
  logger: new BunyanLogger(),
});

-- In middleware and interceptors use new util method to access Request.

Change:

const request = context.switchToHttp().getRequest();

To:

const request = getRequestFromExecutionContext(context);

-- Add @ResolveProperty(), @Parent and @GQLContext annotations to any graphql property resolver methods e.g.

 import { Parent, ResolveProperty, Resolver, Context as GqlContext } from '@nestjs/graphql';

 ...

 @ResolveProperty('recipients')
  async recipients(
    @Parent() parent: Message,
    @GqlContext() context: Context,
  ): Promise<Recipient[]> {}

5.3.2 (2020-04-09)

Revert changes in 5.3.1 as there was nothing wrong with logging in the end.

5.3.1 - do not use (2020-04-09)

SKIP this release. Some internal changes to try to resolve an issue with logging that ended up being reverted in following release.

5.3.0 (2020-04-09)

createLogger allows an optional options object to be passed to the bunyan logger. NOTE: this feature has been removed in v7.

5.2.2 (2020-04-09)

Minor internal lib updates

5.2.1 (2020-04-09)

Minor internal lib updates

5.2.0 (2020-04-08)

Optional auth callbacks to build user roles and build additional user properties (backwards-compatible ... not required)
To utilise create an @Injectable class that implements AuthCallbacks and define one or more methods

5.1.2 (2020-01-31)

Fix typings to support multiple query predicates for arrays of primitives and union types.

Older releases

For older releases see the original repository this was forked from a repository that no longer exists. For convenience we have copied the changelog from the old library here: old library changelog.

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

10.0.1 (2023-09-14)

10.0.0 (2023-08-23)

BREAKING CHANGES

NestJS 10:

9.0.1 (2023-08-17)

9.0.0 (2021-11-10)

BREAKING CHANGES

NestJS 8:

IOTS 2:

8.2.1 (2021-11-08)

8.2.0 (2021-08-20)

8.1.2 (2021-08-18)

8.1.1 (2021-05-03)

8.1.0 (2021-04-06)

8.0.1 (2021-03-22)

8.0.0 (2021-03-09)

BREAKING CHANGES

7.5.5 (2021-01-15)

7.5.4 (2020-12-11)

7.5.3 (2020-11-20)

7.5.2 (2020-11-10)

7.5.1 (2020-11-10)

7.5.0 (2020-11-10)

7.4.3 (2020-10-27)

7.4.2 (2020-10-21)

7.4.1 (2020-10-14)

7.4.0 (2020-09-20)

7.3.0 (2020-09-02)

7.2.0 (2020-07-23)

7.1.0 (2020-05-26) 7.x goes GA

Breaking changes - migrating from v6

6.0.1 (2020-04-21)

6.0.0-rc.2 (2020-04-21)

6.0.0-rc.1 (2020-04-21)

6.0.0-rc.0 (2020-03-00)

Breaking changes:

5.3.2 (2020-04-09)

5.3.1 - do not use (2020-04-09)

5.3.0 (2020-04-09)

5.2.2 (2020-04-09)

5.2.1 (2020-04-09)

5.2.0 (2020-04-08)

5.1.2 (2020-01-31)

Older releases