@adonisjs/session 6.1.4 → 6.2.0

package/build/adonis-typings/session.d.ts

@@ -220,6 +220,21 @@ declare module '@ioc:Adonis/Addons/Session' {
      * SessionClient exposes the API to set session data as a client
      */
     export interface SessionClientContract extends StoreContract {
+        /**
+         * Find if the sessions are enabled
+         */
+        isEnabled(): boolean;
+        /**
+         * Flash messages store to set flash messages
+         */
+        flashMessages: StoreContract;
+        /**
+         * Load session data from the driver
+         */
+        load(): Promise<{
+            session: Record<string, any>;
+            flashMessages: Record<string, any> | null;
+        }>;
         /**
          * Commits the session data to the session store and returns
          * the session id and cookie name for it to be accessible
@@ -228,6 +243,7 @@ declare module '@ioc:Adonis/Addons/Session' {
         commit(): Promise<{
             cookieName: string;
             sessionId: string;
+            signedSessionId: string;
         }>;
         /**
          * Forget the session data.
@@ -238,6 +254,7 @@ declare module '@ioc:Adonis/Addons/Session' {
      * Session manager shape
      */
     export interface SessionManagerContract {
+        isEnabled(): boolean;
         application: ApplicationContract;
         client(): SessionClientContract;
         create(ctx: HttpContextContract): SessionContract;

package/build/adonis-typings/tests.d.ts

@@ -0,0 +1,50 @@
+import '@japa/api-client';
+import { AllowedSessionValues, SessionClientContract } from '@ioc:Adonis/Addons/Session';
+declare module '@japa/api-client' {
+    interface ApiRequest {
+        sessionClient: SessionClientContract;
+        /**
+         * Send session values in the request
+         */
+        withSession(session: Record<string, AllowedSessionValues>): this;
+        /**
+         * Send flash messages in the request
+         */
+        withFlashMessages(messages: Record<string, AllowedSessionValues>): this;
+    }
+    interface ApiResponse {
+        /**
+         * A copy of session data loaded from the driver
+         */
+        sessionJar: {
+            session: Record<string, any>;
+            flashMessages: Record<string, any> | null;
+        };
+        /**
+         * Get session data
+         */
+        session(): Record<string, any>;
+        /**
+         * Get flash messages set by the server
+         */
+        flashMessages(): Record<string, any>;
+        /**
+         * Assert response to contain a given session and optionally
+         * has the expected value
+         */
+        assertSession(key: string, value?: any): void;
+        /**
+         * Assert response to not contain a given session
+         */
+        assertSessionMissing(key: string): void;
+        /**
+         * Assert response to contain a given flash message and optionally
+         * has the expected value
+         */
+        assertFlashMessage(key: string, value?: any): void;
+        /**
+         * Assert response to not contain a given session
+         */
+        assertFlashMissing(key: string): void;
+    }
+}

package/build/adonis-typings/tests.js

@@ -0,0 +1,11 @@
+"use strict";
+/*
+ * @adonisjs/session
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+require("@japa/api-client");

package/build/providers/SessionProvider.d.ts

@@ -19,5 +19,13 @@ export default class SessionProvider {
      * Register Session Manager
      */
     register(): void;
+    /**
+     * Register bindings for tests
+     */
+    protected registerTestsBindings(): void;
+    /**
+     * Register server bindings
+     */
+    protected registerServerBindings(): void;
     boot(): void;
 }

package/build/providers/SessionProvider.js

@@ -24,39 +24,33 @@ class SessionProvider {
             return new SessionManager(this.app, this.app.config.get('session', {}));
         });
     }
-    boot() {
-        /**
-         * Hook session into ctx during request cycle. We make use of hooks over
-         * middleware, since Hooks guarantee the `after` execution even when
-         * any middleware or controller raises exception.
-         */
+    /**
+     * Register bindings for tests
+     */
+    registerTestsBindings() {
+        this.app.container.withBindings([
+            'Japa/Preset/ApiRequest',
+            'Japa/Preset/ApiResponse',
+            'Japa/Preset/ApiClient',
+            'Adonis/Addons/Session',
+        ], (ApiRequest, ApiResponse, ApiClient, Session) => {
+            const { defineTestsBindings } = require('../src/Bindings/Tests');
+            defineTestsBindings(ApiRequest, ApiResponse, ApiClient, Session);
+        });
+    }
+    /**
+     * Register server bindings
+     */
+    registerServerBindings() {
         this.app.container.withBindings(['Adonis/Core/Server', 'Adonis/Core/HttpContext', 'Adonis/Addons/Session'], (Server, HttpContext, Session) => {
-            /**
-             * Sharing session with the context
-             */
-            HttpContext.getter('session', function session() {
-                return Session.create(this);
-            }, true);
-            /**
-             * Do not register hooks when sessions are disabled
-             */
-            if (!this.app.config.get('session.enabled', true)) {
-                return;
-            }
-            /**
-             * Initiate session store
-             */
-            Server.hooks.before(async (ctx) => {
-                await ctx.session.initiate(false);
-            });
-            /**
-             * Commit store mutations
-             */
-            Server.hooks.after(async (ctx) => {
-                await ctx.session.commit();
-            });
+            const { defineServerBindings } = require('../src/Bindings/Server');
+            defineServerBindings(HttpContext, Server, Session);
         });
     }
+    boot() {
+        this.registerServerBindings();
+        this.registerTestsBindings();
+    }
 }
 exports.default = SessionProvider;
 SessionProvider.needsApplication = true;

package/build/src/Bindings/Server.d.ts

@@ -0,0 +1,10 @@
+/// <reference path="../../adonis-typings/index.d.ts" />
+/// <reference types="@adonisjs/http-server/build/adonis-typings" />
+import { ServerContract } from '@ioc:Adonis/Core/Server';
+import { SessionManagerContract } from '@ioc:Adonis/Addons/Session';
+import { HttpContextConstructorContract } from '@ioc:Adonis/Core/HttpContext';
+/**
+ * Share "session" with the HTTP context. Define hooks to initiate and
+ * commit session when sessions are enabled.
+ */
+export declare function defineServerBindings(HttpContext: HttpContextConstructorContract, Server: ServerContract, Session: SessionManagerContract): void;

package/build/src/Bindings/Server.js

@@ -0,0 +1,42 @@
+"use strict";
+/*
+ * @adonisjs/session
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineServerBindings = void 0;
+/**
+ * Share "session" with the HTTP context. Define hooks to initiate and
+ * commit session when sessions are enabled.
+ */
+function defineServerBindings(HttpContext, Server, Session) {
+    /**
+     * Sharing session with the context
+     */
+    HttpContext.getter('session', function session() {
+        return Session.create(this);
+    }, true);
+    /**
+     * Do not register hooks when sessions are disabled
+     */
+    if (!Session.isEnabled()) {
+        return;
+    }
+    /**
+     * Initiate session store
+     */
+    Server.hooks.before(async (ctx) => {
+        await ctx.session.initiate(false);
+    });
+    /**
+     * Commit store mutations
+     */
+    Server.hooks.after(async (ctx) => {
+        await ctx.session.commit();
+    });
+}
+exports.defineServerBindings = defineServerBindings;

package/build/src/Bindings/Tests.d.ts

@@ -0,0 +1,7 @@
+/// <reference path="../../adonis-typings/index.d.ts" />
+import { ContainerBindings } from '@ioc:Adonis/Core/Application';
+import { SessionManagerContract } from '@ioc:Adonis/Addons/Session';
+/**
+ * Define test bindings
+ */
+export declare function defineTestsBindings(ApiRequest: ContainerBindings['Japa/Preset/ApiRequest'], ApiResponse: ContainerBindings['Japa/Preset/ApiResponse'], ApiClient: ContainerBindings['Japa/Preset/ApiClient'], SessionManager: SessionManagerContract): void;

package/build/src/Bindings/Tests.js

@@ -0,0 +1,125 @@
+"use strict";
+/*
+ * @adonisjs/session
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineTestsBindings = void 0;
+/**
+ * Define test bindings
+ */
+function defineTestsBindings(ApiRequest, ApiResponse, ApiClient, SessionManager) {
+    /**
+     * Set "sessionClient" on the api request
+     */
+    ApiRequest.getter('sessionClient', function () {
+        return SessionManager.client();
+    }, true);
+    /**
+     * Send session values in the request
+     */
+    ApiRequest.macro('withSession', function (session) {
+        if (!this.sessionClient.isEnabled()) {
+            throw new Error('Cannot set session. Make sure to enable it inside "config/session" file');
+        }
+        this.sessionClient.merge(session);
+        return this;
+    });
+    /**
+     * Send flash messages in the request
+     */
+    ApiRequest.macro('withFlashMessages', function (messages) {
+        if (!this.sessionClient.isEnabled()) {
+            throw new Error('Cannot set flash messages. Make sure to enable the session inside "config/session" file');
+        }
+        this.sessionClient.flashMessages.merge(messages);
+        return this;
+    });
+    /**
+     * Returns reference to the session data from the session
+     * jar
+     */
+    ApiResponse.macro('session', function () {
+        return this.sessionJar.session;
+    });
+    /**
+     * Returns reference to the flash messages from the session
+     * jar
+     */
+    ApiResponse.macro('flashMessages', function () {
+        return this.sessionJar.flashMessages || {};
+    });
+    /**
+     * Assert response to contain a given session and optionally
+     * has the expected value
+     */
+    ApiResponse.macro('assertSession', function (name, value) {
+        this.ensureHasAssert();
+        this.assert.property(this.session(), name);
+        if (value !== undefined) {
+            this.assert.deepEqual(this.session()[name], value);
+        }
+    });
+    /**
+     * Assert response to not contain a given session
+     */
+    ApiResponse.macro('assertSessionMissing', function (name) {
+        this.ensureHasAssert();
+        this.assert.notProperty(this.session(), name);
+    });
+    /**
+     * Assert response to contain a given flash message and optionally
+     * has the expected value
+     */
+    ApiResponse.macro('assertFlashMessage', function (name, value) {
+        this.ensureHasAssert();
+        this.assert.property(this.flashMessages(), name);
+        if (value !== undefined) {
+            this.assert.deepEqual(this.flashMessages()[name], value);
+        }
+    });
+    /**
+     * Assert response to not contain a given session
+     */
+    ApiResponse.macro('assertFlashMissing', function (name) {
+        this.ensureHasAssert();
+        this.assert.notProperty(this.flashMessages(), name);
+    });
+    /**
+     * Hook into request and persist session data to be available
+     * on the server during the request.
+     */
+    ApiClient.setup(async (request) => {
+        /**
+         * Persist session data and set the session id within the
+         * cookie
+         */
+        const { cookieName, sessionId } = await request.sessionClient.commit();
+        request.cookie(cookieName, sessionId);
+        /**
+         * Cleanup if request has error. Otherwise the teardown
+         * hook will clear
+         */
+        return async (error) => {
+            if (error) {
+                await request.sessionClient.forget();
+            }
+        };
+    });
+    /**
+     * Load messages from the session store and keep a reference to it
+     * inside the response object.
+     *
+     * We also destroy the session after getting a copy of the session
+     * data
+     */
+    ApiClient.teardown(async (response) => {
+        response.sessionJar = await response.request.sessionClient.load();
+        await response.request.sessionClient.forget();
+    });
+}
+exports.defineTestsBindings = defineTestsBindings;

package/build/src/Client/index.d.ts

@@ -15,9 +15,29 @@ export declare class SessionClient extends Store implements SessionClientContrac
      * multiple client instances for a different session id
      */
     private sessionId;
+    /**
+     * Session key for setting flash messages
+     */
+    private flashMessagesKey;
+    /**
+     * Flash messages store. They are merged with the session data during
+     * commit
+     */
+    flashMessages: Store;
     constructor(config: SessionConfig, driver: SessionDriverContract, cookieClient: CookieClientContract, values: {
         [key: string]: any;
     } | null);
+    /**
+     * Find if the sessions are enabled
+     */
+    isEnabled(): boolean;
+    /**
+     * Load session from the driver
+     */
+    load(): Promise<{
+        session: any;
+        flashMessages: any;
+    }>;
     /**
      * Commits the session data to the session store and returns
      * the session id and cookie name for it to be accessible
@@ -25,6 +45,7 @@ export declare class SessionClient extends Store implements SessionClientContrac
      */
     commit(): Promise<{
         sessionId: string;
+        signedSessionId: string;
         cookieName: string;
     }>;
     /**

package/build/src/Client/index.js

@@ -26,6 +26,33 @@ class SessionClient extends Store_1.Store {
          * multiple client instances for a different session id
          */
         this.sessionId = (0, helpers_1.cuid)();
+        /**
+         * Session key for setting flash messages
+         */
+        this.flashMessagesKey = '__flash__';
+        /**
+         * Flash messages store. They are merged with the session data during
+         * commit
+         */
+        this.flashMessages = new Store_1.Store({});
+    }
+    /**
+     * Find if the sessions are enabled
+     */
+    isEnabled() {
+        return this.config.enabled;
+    }
+    /**
+     * Load session from the driver
+     */
+    async load() {
+        const contents = await this.driver.read(this.sessionId);
+        const store = new Store_1.Store(contents);
+        const flashMessages = store.pull(this.flashMessagesKey, null);
+        return {
+            session: store.all(),
+            flashMessages,
+        };
     }
     /**
      * Commits the session data to the session store and returns
@@ -33,10 +60,16 @@ class SessionClient extends Store_1.Store {
      * by the server
      */
     async commit() {
+        this.set(this.flashMessagesKey, this.flashMessages.all());
         await this.driver.write(this.sessionId, this.toJSON());
+        /**
+         * Clear from the session client memory
+         */
         this.clear();
+        this.flashMessages.clear();
         return {
-            sessionId: this.cookieClient.sign(this.config.cookieName, this.sessionId),
+            sessionId: this.sessionId,
+            signedSessionId: this.cookieClient.sign(this.config.cookieName, this.sessionId),
             cookieName: this.config.cookieName,
         };
     }
@@ -44,8 +77,15 @@ class SessionClient extends Store_1.Store {
      * Clear the session store
      */
     async forget() {
+        /**
+         * Clear from the session client memory
+         */
         this.clear();
-        this.driver.destroy(this.sessionId);
+        this.flashMessages.clear();
+        /**
+         * Clear with the driver
+         */
+        await this.driver.destroy(this.sessionId);
     }
 }
 exports.SessionClient = SessionClient;

package/build/src/SessionManager/index.d.ts

@@ -59,6 +59,10 @@ export declare class SessionManager implements SessionManagerContract {
      * An hard exception is raised in case of invalid driver name
      */
     private createDriver;
+    /**
+     * Find if the sessions are enabled
+     */
+    isEnabled(): boolean;
     /**
      * Creates an instance of the session client
      */

package/build/src/SessionManager/index.js

@@ -41,7 +41,7 @@ class SessionManager {
          * Explicitly overwriting `cookie.expires` and `cookie.maxAge` from
          * the user defined config
          */
-        const processedConfig = Object.assign({}, config, {
+        const processedConfig = Object.assign({ enabled: true }, config, {
             cookie: {
                 ...config.cookie,
                 expires: undefined,
@@ -118,6 +118,12 @@ class SessionManager {
                 return this.createExtendedDriver(ctx);
         }
     }
+    /**
+     * Find if the sessions are enabled
+     */
+    isEnabled() {
+        return this.config.enabled;
+    }
     /**
      * Creates an instance of the session client
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/session",
-  "version": "6.1.4",
+  "version": "6.2.0",
   "description": "Session provider for AdonisJS",
   "typings": "./build/adonis-typings/index.d.ts",
   "main": "build/providers/SessionProvider.js",
@@ -19,32 +19,33 @@
     "@adonisjs/core": "^5.5.0"
   },
   "devDependencies": {
-    "@adonisjs/core": "^5.5.0",
-    "@adonisjs/mrm-preset": "^5.0.2",
+    "@adonisjs/core": "^5.6.2",
+    "@adonisjs/mrm-preset": "^5.0.3",
     "@adonisjs/redis": "^7.1.1",
     "@adonisjs/require-ts": "^2.0.10",
-    "@japa/assert": "^1.2.3",
-    "@japa/run-failed-tests": "^1.0.3",
-    "@japa/runner": "^1.2.0",
-    "@japa/spec-reporter": "^1.1.7",
+    "@japa/assert": "^1.3.3",
+    "@japa/preset-adonis": "^1.0.11",
+    "@japa/run-failed-tests": "^1.0.7",
+    "@japa/runner": "^2.0.6",
+    "@japa/spec-reporter": "^1.1.12",
     "@poppinss/dev-utils": "^2.0.2",
-    "@types/node": "^17.0.21",
-    "@types/supertest": "^2.0.11",
+    "@types/node": "^17.0.23",
+    "@types/supertest": "^2.0.12",
     "commitizen": "^4.2.4",
     "copyfiles": "^2.4.1",
     "cz-conventional-changelog": "^3.3.0",
     "del-cli": "^4.0.1",
-    "eslint": "^8.10.0",
-    "eslint-config-prettier": "^8.4.0",
+    "eslint": "^8.12.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-adonis": "^2.1.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "github-label-sync": "^2.0.2",
+    "github-label-sync": "^2.1.1",
     "husky": "^7.0.4",
-    "mrm": "^3.0.10",
-    "np": "^7.6.0",
-    "prettier": "^2.5.1",
+    "mrm": "^4.0.0",
+    "np": "^7.6.1",
+    "prettier": "^2.6.2",
     "supertest": "^6.2.2",
-    "typescript": "^4.5.5"
+    "typescript": "^4.6.3"
   },
   "scripts": {
     "mrm": "mrm --preset=@adonisjs/mrm-preset",