next-rs-middleware 0.3.0

Middleware implementation for next.rs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

use regex::Regex;

#[derive(Debug, Clone)]
pub enum PathMatcher {
    Exact(String),
    Prefix(String),
    Regex(String),
    All,
}

impl PathMatcher {
    pub fn matches(&self, path: &str) -> bool {
        match self {
            PathMatcher::Exact(p) => path == p,
            PathMatcher::Prefix(p) => path.starts_with(p),
            PathMatcher::Regex(pattern) => Regex::new(pattern)
                .map(|re| re.is_match(path))
                .unwrap_or(false),
            PathMatcher::All => true,
        }
    }
}

#[derive(Debug, Clone)]
pub struct MiddlewareMatcher {
    include: Vec<PathMatcher>,
    exclude: Vec<PathMatcher>,
}

impl MiddlewareMatcher {
    pub fn new() -> Self {
        Self {
            include: Vec::new(),
            exclude: Vec::new(),
        }
    }

    pub fn include(mut self, matcher: PathMatcher) -> Self {
        self.include.push(matcher);
        self
    }

    pub fn exclude(mut self, matcher: PathMatcher) -> Self {
        self.exclude.push(matcher);
        self
    }

    pub fn matches(&self, path: &str) -> bool {
        for excluded in &self.exclude {
            if excluded.matches(path) {
                return false;
            }
        }

        if self.include.is_empty() {
            return true;
        }

        for included in &self.include {
            if included.matches(path) {
                return true;
            }
        }

        false
    }

    pub fn from_config(patterns: Vec<&str>) -> Self {
        let mut matcher = Self::new();
        for pattern in patterns {
            if pattern.ends_with("*") {
                matcher.include.push(PathMatcher::Prefix(
                    pattern.trim_end_matches('*').to_string(),
                ));
            } else if pattern.starts_with("^") || pattern.contains("(") {
                matcher
                    .include
                    .push(PathMatcher::Regex(pattern.to_string()));
            } else {
                matcher
                    .include
                    .push(PathMatcher::Exact(pattern.to_string()));
            }
        }
        matcher
    }
}

impl Default for MiddlewareMatcher {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_exact_matcher() {
        let matcher = PathMatcher::Exact("/about".to_string());
        assert!(matcher.matches("/about"));
        assert!(!matcher.matches("/about/"));
        assert!(!matcher.matches("/about/team"));
    }

    #[test]
    fn test_prefix_matcher() {
        let matcher = PathMatcher::Prefix("/api/".to_string());
        assert!(matcher.matches("/api/users"));
        assert!(matcher.matches("/api/posts/1"));
        assert!(!matcher.matches("/about"));
    }

    #[test]
    fn test_regex_matcher() {
        let matcher = PathMatcher::Regex(r"^/blog/\d+$".to_string());
        assert!(matcher.matches("/blog/123"));
        assert!(!matcher.matches("/blog/abc"));
    }

    #[test]
    fn test_middleware_matcher_include() {
        let matcher = MiddlewareMatcher::new()
            .include(PathMatcher::Prefix("/api/".to_string()))
            .include(PathMatcher::Prefix("/admin/".to_string()));

        assert!(matcher.matches("/api/users"));
        assert!(matcher.matches("/admin/dashboard"));
        assert!(!matcher.matches("/public/file"));
    }

    #[test]
    fn test_middleware_matcher_exclude() {
        let matcher = MiddlewareMatcher::new()
            .include(PathMatcher::All)
            .exclude(PathMatcher::Prefix("/static/".to_string()))
            .exclude(PathMatcher::Prefix("/_next/".to_string()));

        assert!(matcher.matches("/api/users"));
        assert!(!matcher.matches("/static/image.png"));
        assert!(!matcher.matches("/_next/chunk.js"));
    }

    #[test]
    fn test_from_config() {
        let matcher = MiddlewareMatcher::from_config(vec!["/api/*", "/admin/*", "/login"]);

        assert!(matcher.matches("/api/users"));
        assert!(matcher.matches("/admin/"));
        assert!(matcher.matches("/login"));
        assert!(!matcher.matches("/public"));
    }
}